<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>cat segments API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'cat-segments.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-segments.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-segments.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/cat-segments.html" rel="nofollow" target="_blank">../en/cat-segments.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="cat.html">cat APIs</a></span>
»
<span class="breadcrumb-node">cat segments API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="cat-shards.html">« cat shards API</a>
</span>
<span class="next">
<a href="cat-snapshots.html">cat snapshots API »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="cat-segments"></a>cat segments API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/segments.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Returns low-level information about the <a href="https://lucene.apache.org/core/" class="ulink" target="_top">Lucene</a>
segments in index shards, similar to the <a class="xref" href="indices-segments.html" title="Index segments API">indices segments</a>
API.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-segments-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/segments.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">GET /_cat/segments/&lt;index&gt;</code></p>
<p><code class="literal">GET /_cat/segments</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-segments-path-params"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/segments.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;index&gt;</code>
</span>
</dt>
<dd>
(Optional, string) Comma-separated list or wildcard expression of index names
used to limit the request.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-segments-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/segments.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">bytes</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#byte-units" title="Byte size units">byte size units</a>) Unit used to display byte values.
</dd>
<dt>
<span class="term">
<code class="literal">format</code>
</span>
</dt>
<dd>
(Optional, string) Short version of the
<a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html" class="ulink" target="_top">HTTP accept header</a>.
Valid values include JSON, YAML, etc.
</dd>
<dt>
<span class="term">
<code class="literal">h</code>
</span>
</dt>
<dd>
<p>
(Optional, string) Comma-separated list of column names to display.
</p>
<p>If you do not specify which columns to include, the API returns the default
columns in the order listed below. If you explicitly specify one or more
columns, it only returns the specified columns.</p>
<p>Valid columns are:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">index</code>, <code class="literal">i</code>, <code class="literal">idx</code>
</span>
</dt>
<dd>
(Default) Name of the index, such as <code class="literal">twitter</code>.
</dd>
<dt>
<span class="term">
<code class="literal">shard</code>, <code class="literal">s</code>, <code class="literal">sh</code>
</span>
</dt>
<dd>
(Default) Name of the shard.
</dd>
<dt>
<span class="term">
<code class="literal">prirep</code>, <code class="literal">p</code>, <code class="literal">pr</code>, <code class="literal">primaryOrReplica</code>
</span>
</dt>
<dd>
(Default) Shard type. Returned values are <code class="literal">primary</code> or <code class="literal">replica</code>.
</dd>
<dt>
<span class="term">
<code class="literal">ip</code>
</span>
</dt>
<dd>
(Default) IP address of the segment’s shard, such as <code class="literal">127.0.1.1</code>.
</dd>
<dt>
<span class="term">
<code class="literal">segment</code>
</span>
</dt>
<dd>
(Default)
Name of the segment, such as <code class="literal">_0</code>. The segment name is derived from
the segment generation and used internally to create file names in the directory
of the shard.
</dd>
<dt>
<span class="term">
<code class="literal">generation</code>
</span>
</dt>
<dd>
(Default)
Generation number, such as <code class="literal">0</code>. Elasticsearch increments this generation number
for each segment written. Elasticsearch then uses this number to derive the segment name.
Generation number, such as <code class="literal">0</code>. Elasticsearch increments this generation number
for each segment written. Elasticsearch then uses this number to derive the segment name.
</dd>
<dt>
<span class="term">
<code class="literal">docs.count</code>
</span>
</dt>
<dd>
(Default)
Number of non-deleted documents in the segment, such as <code class="literal">25</code>. This
number is based on Lucene documents and may include documents from
<a class="xref" href="nested.html" title="Nested datatype">nested</a> fields.
</dd>
<dt>
<span class="term">
<code class="literal">docs.deleted</code>
</span>
</dt>
<dd>
(Default)
Number of deleted documents in the segment, such as <code class="literal">0</code>. This number
is based on Lucene documents. Elasticsearch reclaims the disk space of deleted Lucene
documents when a segment is merged.
</dd>
<dt>
<span class="term">
<code class="literal">size</code>
</span>
</dt>
<dd>
(Default)
Disk space used by the segment, such as <code class="literal">50kb</code>.
</dd>
<dt>
<span class="term">
<code class="literal">size.memory</code>
</span>
</dt>
<dd>
<p>
(Default)
Bytes of segment data stored in memory for efficient search,
such as <code class="literal">1264</code>.
</p>
<p>A value of <code class="literal">-1</code> indicates Elasticsearch was unable to compute this number.</p>
</dd>
<dt>
<span class="term">
<code class="literal">committed</code>
</span>
</dt>
<dd>
<p>
(Default)
If <code class="literal">true</code>,
the segments is synced to disk. Segments that are synced can survive a hard reboot.
</p>
<p>If <code class="literal">false</code>,
the data from uncommitted segments is also stored in
the transaction log so that Elasticsearch is able to replay
changes on the next start.</p>
</dd>
<dt>
<span class="term">
<code class="literal">searchable</code>
</span>
</dt>
<dd>
<p>
(Default)
If <code class="literal">true</code>,
the segment is searchable.
</p>
<p>If <code class="literal">false</code>,
the segment has most likely been written to disk
but needs a <a class="xref" href="indices-refresh.html" title="Refresh API">refresh</a> to be searchable.</p>
</dd>
<dt>
<span class="term">
<code class="literal">version</code>
</span>
</dt>
<dd>
(Default)
Version of Lucene used to write the segment.
</dd>
<dt>
<span class="term">
<code class="literal">compound</code>
</span>
</dt>
<dd>
(Default) If <code class="literal">true</code>, the segment is stored in a compound file. This means Lucene
merged all files from the segment in a single file to save file descriptors.
</dd>
<dt>
<span class="term">
<code class="literal">id</code>
</span>
</dt>
<dd>
ID of the node, such as <code class="literal">k0zy</code>.
</dd>
</dl>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">help</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the response includes help information. Defaults
to <code class="literal">false</code>.
</dd>
<dt>
<span class="term">
<code class="literal">s</code>
</span>
</dt>
<dd>
(Optional, string) Comma-separated list of column names or column aliases used
to sort the response.
</dd>
<dt>
<span class="term">
<code class="literal">v</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the response includes column headings.
Defaults to <code class="literal">false</code>.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-segments-api-example"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/segments.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_cat/segments?v</pre>
</div>
<div class="console_widget" data-snippet="snippets/1377.console"></div>
<p>The API returns the following response:</p>
<div class="pre_wrapper lang-txt">
<pre class="programlisting prettyprint lang-txt">index shard prirep ip        segment generation docs.count docs.deleted size size.memory committed searchable version compound
test  0     p      127.0.0.1 _0               0          1            0  3kb        2042 false     true       8.5.1   true
test1 0     p      127.0.0.1 _0               0          1            0  3kb        2042 false     true       8.5.1   true</pre>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="cat-shards.html">« cat shards API</a>
</span>
<span class="next">
<a href="cat-snapshots.html">cat snapshots API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>